home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
sfwcdr.zip
/
SFWCDR.DOC
next >
Wrap
Text File
|
1990-12-09
|
12KB
|
259 lines
SFWCDR
Wildcat Door To SPITFIRE Conversion Program
Version 1.1
Copyright (C) By Mike Woltz, 1989, 1990
Buffalo Creek Software
A Member Of
The Association Of Shareware Professionals
INTRODUCTION
------------
SFWCDR is a utility written by Mike Woltz, author of SPITFIRE, to
enable Wildcat door programs to be used with SPITFIRE. Using SFWCDR
you may setup the Wildcat door program to be used either as a SPITFIRE
door or as a sysop configurable command from the SPITFIRE Main, Message
or File menus.
COMMAND LINE PARAMETERS
-----------------------
SFWCDR uses two command line parameters during its operation.
/P - Must be used to determine the drive and directory where
the Wildcat door program files exist and the placement
of the CALLINFO.BBS.
/WC1 - Should be used to designate the Wildcat door being run
was written for Wildcat Version 1.? and a CALLINFO.BBS
is written using Wildcat V1.? format. If the /WC1
command line parameter is not used, SFWCDR defaults
to Wildcat Version 2.? and the CALLINFO.BBS is written
using Wildcat V2.? format.
For instance, let's assume you wanted to run a Wildcat door
program that was written for Wildcat Version 1.?. Also assume,
SPITFIRE is being run from the SF directory of drive C and a DOOR_A
directory was created from the SF directory for running the Wildcat
door. With these assumptions, your command line would look like this:
SFWCDR /P C:\SF\DOOR_A /WC1
Under the same circumstances, if you were running a door written for
Wildcat Version 2.?, your command line would look like this:
SFWCDR /P C:\SF\DOOR_A
It should be noted that if no /P command line parameter is set, SFWCDR
will not run.
HOW IT WORKS
------------
SFWCDR.EXE must exist in the main SPITFIRE system files directory.
This is absolutely necessary for SFWCDR to access other files which
are required for the proper execution of SFWCDR.
When SFWCDR is executed it first will check for the SFDOORS.DAT file.
If this is found, this signifies that the Wildcat door program has been
set up to run as a SPITFIRE door. If this is not found, it continues
to look for SFMAIN.DAT, SFMESS.DAT or SFFILE.DAT, in the order listed.
If one of these files are found it signifies the Wildcat door program
is being run as a sysop configurable command from the corresponding menu.
This allows SFWCDR to determine which batch file will be used to run the
Wildcat door program. If none of the above mentioned DAT files are
found SFWCDR will not run.
SFWCDR will then read and obtain information from the SFNODE.DAT,
SFSYSTEM.DAT, SFDOORS.DAT, SFUSERS.DAT, and DAILYLMT.DAT. The
information obtained from these files is used to create CALLINFO.BBS.
CALLINFO.BBS is a data file used with Wildcat door programs.
CALLINFO.BBS is then written to the directory you specified earlier
with the /P command line parameter. The format of the CALLINFO.BBS
data file will be dependent upon whether you have used the /WC1
command line parameter. As mentioned earlier, if the /WC1 command
line parameter is used the CALLINFO.BBS is written in the format
of that used by Wildcat Version 1.?. If the /WC1 is omitted,
the CALLINFO.BBS is written in the format of that used by Wildcat
Version 2.?.
It should also be mentioned that if SFWCDR fails to run because
the /P command line parameter has not been specified or due to the
inability to locate the necessary DAT file, SFWCDR will send an
ERRORLEVEL 1 to DOS. If DAILYLMT.DAT is not found, SFWCDR will
default to 20 downloads per day and 1000K downloadable bytes per day.
USING SFWCDR TO RUN A SPITFIRE DOOR
-----------------------------------
The first thing you will need to be concerned with when using
SFWCDR to run a SPITFIRE door will be to create or modify an existing
SFDOOR.MNU. Using your favorite text editor you will need to
include a line that contains a brief description of the door program
you intend to run, a comma, and the security level required by the
user to access this SPITFIRE door. (The line number should correspond
to the door number you are running your door program in. For this
example we will be using Door number 1. For more detailed information
refer to the SPITFIRE manual.) A typical line of your SFDOOR.MNU might
look like this:
The Door Description,10
If you are using SFDR[x].BBS/CLR sysop created non-ansi and ansi
menus these will need to be modified also.
Next you will also need to modify your SF.BAT file with your
favorite text editor. Locate the line which contains :DOOR_A.
You will need to place your door A commands (valid DOS commands,
program execution, etc.) between :DOOR_A and GOTO LOOP. A typical
example of this portion of your SF.BAT might be changed to read as
listed below:
:DOOR_A
SFWCDR /P C:\SF\DOOR_A
IF ERRORLEVEL 1 GOTO LOOP
CD\SF\DOOR_A
PROGRAM NAME
DEL CALLINFO.BBS
CD\SF
GOTO LOOP
If the Wildcat door program you are using requires the use of a
configuration file, the name of the configuration file would be
added on the same line as, and after the PROGRAM NAME. For instance,
instead of PROGRAM NAME you would need PROGRAM NAME and a blank
space followed by the name of the configuration file. Or if the door
was written for Wildcat Version 1.?, you would need to add the
/WC1 command line parameter.
USING SFWCDR FROM A SPITFIRE MENU
---------------------------------
SPITFIRE has a sysop configurable command for the Main, Message
and File menus. The sysop configurable command is executed through
a batch file which corresponds to the menu it is being run from. In
other words, SFMAIN.BAT runs the sysop configurable command from the
Main Menu, SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT
the one from the File Menu. The commands necessary to execute SFWCDR
and run the Wildcat door program are set up in the batch file which
corresponds to the menu you wish to have program run from.
The first thing you will need to establish is which of these menus
you wish to use to run the Wildcat door program. For this purpose,
let's assume that it is going to be set up so it can be run from the
Main Menu. (It should be noted the set up procedure will be the same
regardless of which Menu you are running SFWCDR and the Wildcat door
program from.)
Next, you will need to decide what you wish to name the command
option and establish what security level will be required for
users of your system to be able to access this option. Once this
is determined you will need to modify the SFMAIN.MNU file using
your favorite text editor, as long as it saves in ASCII format.
(Refer to the SPITFIRE manual for further documentation on this
if needed. It should also be noted that if SFWCDR were being
set up to run from the File Menu, you would need to modify the
SFFILE.MNU file and if it was being set up to be run from the
Message Menu you would need to modify the SFMSG.MNU file.)
Examining the default SFMAIN.MNU file, you will notice the sysop
configurable command appears as:
<K>............. Add Your Own,,1000,@
This will need to be replaced with a Command Character that will
be used to select the option from the menu. It is ABSOLUTELY IMPERATIVE
that the Command Character must not duplicate an existing Command
Character for another menu option. You will then need to include
a brief description of the Wildcat door program you are running, two
commas, the security level required to access this feature, and another
comma followed by the a @. The @ must not be changed! (For more detailed
information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
to your SPITFIRE manual.)
<K>.... Brief Program Description,,10,@
Now you will need to modify the corresponding batch file, SFMAIN.BAT,
so that it can be executed from the Main Menu. Do this using your
favorite text editor, as long as it saves in ASCII format. (Again, it
should be noted that if SFWCDR and the Wildcat door program were being
set up to run from the File Menu, you would need to modify the SFFILE.BAT
file and if it was being set up to be run from the Message Menu you would
need to modify the SFMESS.BAT file.)
The commands you will need to include in your SFMAIN.BAT to run
SFWCDR and the Wildcat door program might look similar to this:
ECHO OFF
BRK OFF
SFWCDR /P C:\SF\DIRNAME
IF ERRORLEVEL 1 GOTO END
CD\SF\DIRNAME
PROGRAM NAME
:END
CD\SF
BRK ON
(BRK is written and copyrighted by Solid Systems, 1985, but can
be downloaded from Buffalo Creek's BBS as well as a number of other
BBS systems. BRK is not required, however, it is recommended since it
will prevent a caller using the CTRL BRK command to terminate the batch
file, gaining access to your system at the DOS level.)
In the above example, C:\SF\DIRNAME refers to the drive and the
directory in which the Wildcat door program files reside. The actual
Wildcat door program name would be entered where PROGRAM NAME is
currently. If the Wildcat door program you are using requires the
use of a configuration file, the name of the configuration file would
be added on the same line as and after the program. For instance,
instead of PROGRAM NAME you would need PROGRAM NAME and a blank
space followed by the name of the configuration file. If the door
was written for Wildcat Version 1.?, you would need to add the
/WC1 command line parameter.
SFWCDR ON A MULTI-NODE SYSTEM
-----------------------------
SFWCDR is fully compatible for operation on a multi-node BBS.
It automatically handles any file locking and file sharing
required during program execution. However, the WWIV door being
used with SFWCDR may not have this capability. Please refer
to the Wildcat door's documentation in regard to it's multi-node
capability.
DISTRIBUTION
------------
SFWCDR is distributed under the shareware concept. You are
free to distribute the SFWCDR program as long as it remains
unmodified and no fee is charged. If you use this program and
find it beneficial a fee is required. A $1.00 fee is required
of registered SPITFIRE Sysops and a $5.00 fee is required of
all others.
DISCLAIMER
----------
Mike Woltz and/or Buffalo Creek Software shall in no way be held
responsible for any damage incurred while operating SFWCDR. All
responsibility lies with the user of the software.
The documentation for SFWCDR is contributed by Jacque Shipley
and The Mother Board BBS. The shareware version of SPITFIRE
and other SPITFIRE utilities are available for download from:
Buffalo Creek's BBS The Mother Board BBS
Mike Woltz, Sysop Jacque Shipley, Sysop
(515) 225-8496 (515) 986-3464
38400/19200/9600/2400/1200 Baud 19200/9600/2400/1200 Baud